/*
 * Niiuzu
 * Copyright (C) 2011  Thierry Nowak
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.niiuzu.client.screen.application;

import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.event.dom.client.HasClickHandlers;
import com.google.gwt.resources.client.ImageResource;
import com.google.gwt.user.client.ui.IsWidget;
import com.mvp4g.client.view.LazyView;

/**
 * Interface de la vue principale de l'application. Celle-ci permet d'avoir un
 * accès sur les conteneurs principaux de l'application.
 */
public interface ApplicationView extends LazyView {

	/**
	 * Affichage du message de chargement de l'application.
	 */
	void showLoadingApplication();

	/**
	 * Supprime le message de chargement de l'application.
	 */
	void removeLoadingApplication();

	/**
	 * Affiche le corps de l'application.
	 */
	void showBodyPanel();

	/**
	 * Définit le widget contenu dans le corps de l'application.
	 * 
	 * @param widget
	 *            nouveau widget qui sera inséré dans le corps de l'application.
	 */
	void setBodyContent(IsWidget widget);

	/**
	 * Affiche une popup contenant la description d'une erreur technique
	 * survenue au cours de l'exécution.
	 * 
	 * @param throwable
	 *            détail de l'erreur.
	 */
	void showPopupError(Throwable throwable);

	/**
	 * Affiche une popup contenant le message d'erreur récupéré.
	 */
	void showPopupErrorMessage(String errorMessage);

	/**
	 * Affiche une popup avec un message d'attente de chargement.
	 */
	void showLoadingMessage(String message);

	/**
	 * Fermeture de la popup du message d'attente de chargement.
	 */
	void hideLoadingMessage();

	/**
	 * Ajoute un bouton contenant un drapeau destiné au choix de la langue.
	 * 
	 * @param flagImage
	 *            resource de l'image du drapeau correspondant à la langue.
	 * @param tooltip
	 *            message affiché dans la tooltip du drapeau.
	 * @param handler
	 *            comportement associé lors d'un clic.
	 */
	void addFlagButton(ImageResource flagImage, String tooltip,
			ClickHandler handler);

	/**
	 * Gestionnaire des comportements d'un clic sur le lien de déconnexion.
	 */
	HasClickHandlers getLogOutHasClickHandlers();

	/**
	 * Affiche le cadre contenant l'état de connexion de l'utilisateur.
	 * 
	 * @param emailAddress
	 *            adresse email de l'utilisateur connecté.
	 */
	void showLogStatusPanel(String emailAddress);

	/**
	 * Cache le cadre contenant l'état de connexion de l'utilisateur.
	 */
	void hideLogStatusPanel();
}
